<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="api-level">H3C CAS云管理平台</div>
</div>
<div id="jd-header">
<h1>查询主机所有虚拟机</h1>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>根据主机id查询指定物理主机下的所有虚拟机。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/host/id/{hostId}/vm</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>GET</dd>
  <dt><b>参数</b></dt>
  <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2">路径参数（Path Parameter）</th>
      </tr>
      <tr>
        <td class="jd-typecol">hostId</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">主机id 。</span><div class="jd-descrdiv">长整数（long）类型。必须。</div>        </td>
      </tr>
  </table>
</dl>
<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>200(OK)：成功。</li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <br>
  <pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Total: 7</pre>
  <dt><b>消息体</b></dt>
  <div class="source">
    <pre class="prettyprint lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;133&lt;/id&gt;<br>    &lt;hostId&gt;2&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;2&lt;/hostPoolId&gt;<br>    &lt;name&gt;cvk_030&lt;/name&gt;<br>    &lt;description/&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;2&lt;/status&gt;<br>    &lt;uuid&gt;857fce74-1f64-441b-893a-820bcda4c705&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;osDesc&gt;Windows&lt;/osDesc&gt;<br>    &lt;createDate&gt;2014-09-15T16:50:46+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;20&lt;/storageCapacity&gt;<br>    &lt;flag&gt;1&lt;/flag&gt;<br>    &lt;type&gt;0&lt;/type&gt;<br>    &lt;deployed&gt;false&lt;/deployed&gt;<br>    &lt;existRaw&gt;false&lt;/existRaw&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;134&lt;/id&gt;<br>    &lt;hostId&gt;2&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;2&lt;/hostPoolId&gt;<br>    &lt;name&gt;cvk_031&lt;/name&gt;<br>    &lt;description/&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;2&lt;/status&gt;<br>    &lt;uuid&gt;4ec365e7-a883-4ba2-863b-1e2d1e40eed9&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;osDesc&gt;Windows&lt;/osDesc&gt;<br>    &lt;createDate&gt;2014-09-15T16:50:46+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;20&lt;/storageCapacity&gt;<br>    &lt;flag&gt;1&lt;/flag&gt;<br>    &lt;type&gt;0&lt;/type&gt;<br>    &lt;deployed&gt;false&lt;/deployed&gt;<br>    &lt;existRaw&gt;false&lt;/existRaw&gt;<br>  &lt;/domain&gt;
...<br>&lt;/list&gt;</pre>
  </div>
</dl>
<dt><a name="detail"></a><b>元素含义</b></dt>
<table class="jd-sumtable" id="pubmethods">
  <tbody>
    <tr>
      <th colspan="2"><span class="prettyprint lang-xml">domain</span>各子元素</th>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">id</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol">hostId</td>
      <td class="jd-linkcol"><span class="sympad">运行的主机ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">clusterId</span></td>
      <td class="jd-linkcol"><span class="sympad">所属的集群 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">hostPoolId</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">所属的主机池 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">description</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机描述信息。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">memory</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机内存大小，</span>单位（M） <span class="sympad">。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">cpu</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机CPU个数。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">status</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机状态。 2：运行 3：关闭 4：暂停。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">uuid</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机UUID。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">osBit</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机安装的操作系统位数。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">system</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机安装的操作系统类型。0：Windows 1：Linux。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">osDesc</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机安装的操作系统描述。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color" >
      <td class="jd-typecol"><span class="prettyprint lang-xml">flag</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机所属标志 0:不属于用户以及用户组 1:属于用户 2:属于用户组。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">type</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机类型 0:CAS虚拟机 1:VMware虚拟机。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">deployed</span></td>
      <td class="jd-linkcol"><span class="sympad">是否快速部署过。 </span>
          <div class="jd-descrdiv">布尔（Boolean）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">existRaw</span></td>
      <td class="jd-linkcol"><span class="sympad">是否存在raw格式。</span>
          <div class="jd-descrdiv">布尔（Boolean）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">autoMigrate</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">是否允许自动迁移。</span>
          <span class="sympad">0：不允许 1：允许。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">createDate</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机创建日期。</span>
          <div class="jd-descrdiv"><span class="sympad">日期</span>（Date）类型。</div></td>
    </tr>
    <tr  class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">storageCapacity</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机镜像存储大小。</span>
          单位（G）
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
</table>
<p>&nbsp;</p>
<h2><a name="example"></a>应用举例</h2>
    <p>1.查询主机id为21下的所有虚拟机信息。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/host/id/21/vm
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source"><pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Content-Type: application/xml
...<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;133&lt;/id&gt;<br>    &lt;hostId&gt;2&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;2&lt;/hostPoolId&gt;<br>    &lt;name&gt;cvk_030&lt;/name&gt;<br>    &lt;description/&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;2&lt;/status&gt;<br>    &lt;uuid&gt;857fce74-1f64-441b-893a-820bcda4c705&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;osDesc&gt;Windows&lt;/osDesc&gt;<br>    &lt;createDate&gt;2014-09-15T16:50:46+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;20&lt;/storageCapacity&gt;<br>    &lt;flag&gt;1&lt;/flag&gt;<br>    &lt;type&gt;0&lt;/type&gt;<br>    &lt;deployed&gt;false&lt;/deployed&gt;<br>    &lt;existRaw&gt;false&lt;/existRaw&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;134&lt;/id&gt;<br>    &lt;hostId&gt;2&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;2&lt;/hostPoolId&gt;<br>    &lt;name&gt;cvk_031&lt;/name&gt;<br>    &lt;description/&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;2&lt;/status&gt;<br>    &lt;uuid&gt;4ec365e7-a883-4ba2-863b-1e2d1e40eed9&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;osDesc&gt;Windows&lt;/osDesc&gt;<br>    &lt;createDate&gt;2014-09-15T16:50:46+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;20&lt;/storageCapacity&gt;<br>    &lt;flag&gt;1&lt;/flag&gt;<br>    &lt;type&gt;0&lt;/type&gt;<br>    &lt;deployed&gt;false&lt;/deployed&gt;<br>    &lt;existRaw&gt;false&lt;/existRaw&gt;<br>  &lt;/domain&gt;<br>&lt;/list&gt;<br><br></pre>
      </div>
    </dl>
</div>
</div>
</div>
</body>
</html>